This document outlines the status and benefits of the V4 and V5 APIs, as well as guidance for organizations considering the transition to V5.

V4 API Status

The V4 API is not planned for deprecation. Organizations can continue to use V4 alongside V5, with data remaining consolidated across both versions.

Benefits of the V5 API

The V5 API introduces several enhancements over V4:

1. Flexible Authentication

• Static API Tokens: Supports the use of static API tokens for authentication.
• JWT Authentication: Supports JSON Web Token (JWT) authentication with:
  • Pre-shared keys
  • Public keys

2. Faster Setup

• Self-Serve Setup: Enables self-serve setup for both authenticated and unauthenticated endpoints, simplifying integration with internal systems.
• OpenAPI Specifications: Provides OpenAPI specifications that allow for:
  • Auto-generation of sample requests
  • Wrapper code generation using Postman and other API clients

3. Improved Performance

• Batching Support: V5 API endpoints support batching of up to 1000 actions in a single request, resulting in significantly improved performance for high-volume applications.

Transitioning to V5

• Development Effort: Transitioning to V5 may require development effort based on the extent of V4 usage within your organization.
• Recommendation: While V4 will continue to function, it is recommended to use V5 for all new integrations to leverage its benefits and ensure long-term compatibility.
• Initial Steps: Start with non-critical systems to familiarize your team with V5 before proceeding to a full migration.

Support and Guidance

For assistance with the transition to V5, please contact our Client Success team or the Taguchi support team for guidance on planning and implementation.